home *** CD-ROM | disk | FTP | other *** search
/ Software of the Month Club 2000 November / Software of the Month - Ultimate Collection Shareware 278.iso / pc / Programs / Productivity / Compass / Templates / Sample.tpl < prev    next >
Encoding:
Text File  |  2000-03-02  |  5.6 KB  |  172 lines
  1. #############################################################################
  2. # Compass Sample Export Template
  3. # Sample.tpl
  4. #
  5. # Blocks:
  6. # =======
  7. #   A template contains several user-defined "blocks."  There are three types
  8. #   of blocks available in Compass v.2.6: MIAN, FOLDERS, and BOOKMARKS.
  9. #
  10. #    A block definition begins with
  11. #   {block_type:block_name}
  12. #   and ends with
  13. #   {/block_type}
  14. #   where block_type is one of the above types and block_name is optional.
  15. #   If block_name is not specified, the block_type will be used as the block_name.
  16. #
  17. #    1. MAIN         - Required.  The main output block.
  18. #                    - If a name is specified, the name will be used as the output file name.
  19. #                    - If no name is specified, the file dialog will pops up.
  20. #                    - For example: {MAIN:C:\123.TXT} will output to C:\123.TXT.
  21. #    2. FOLDERS      - Optional.  Define the format for folders.
  22. #                    - Two options available for FOLDERS block:
  23. #                    - (T): Top level folder only.
  24. #                    - (A): All bookmarks including sub-folders.
  25. #                    - Please see examples below for the use of those options.
  26. #    3. BOOKMARKS    - Optional.  Define the format for bookmarks.
  27. #
  28. #
  29. # Parameters:
  30. # ===========
  31. #   Parameters are surrounded by the dollar signs ($).  There are six built-in
  32. #   general parameters in Compass v.2.6.  Blocks can be accessed, expanded, or evaluated
  33. #   by surrounding the block name with the dollar signs.  For example, $BOOKMARKS$
  34. #   will be expanded according to the format defined in the BOOKMARKS block.
  35. #
  36. #    1. VERSION      - The version of Compass.
  37. #    2. USER         - The registered user name.
  38. #    3. EMAIL        - The email of the registered user.
  39. #    4. SERIAL       - The serial number of the registered copy.
  40. #    5. DATE         - Current date.
  41. #    6. TIME         - Current time.
  42. #    7. COUNT        - Counter for bookmarks or folders.
  43. #    8. TEMPLATE_DIR - Template file directory.
  44. #    9. TEMPLATE_FILE- Template file name.
  45. #    10.OUTPUT_DIR   - Output file directory.
  46. #    11.OUTPUT_FILE  - Output file name.
  47. #
  48. #
  49. # Item data:
  50. # ==========
  51. #   Item data is a special paramters that can be used only inside FOLDERS or
  52. #   BOOKMARKS blocks.  Use dollar signs ($) to access those data.
  53. #
  54. #    1. TITLE
  55. #    2. URL
  56. #    3. FOLDER
  57. #    4. LASTVISIT
  58. #    5. DESCRIPTION
  59. #
  60. #
  61. # Configuration:
  62. # ==============
  63. #   There are two options to control the format of the "description" of bookmark
  64. #   or folder items.  By default, descriptions uses HTML tag <BR> for new lines
  65. #   (to separate two description lines).  Users can change or remove the "new line"
  66. #   by using the following two settings.
  67. #
  68. #   Prefix a percent sign (%) in front of the configuration keyword and use
  69. #   the equal sign (=) to assign values.  For example:
  70. #   %DESC_NEWLINE=YES
  71. #   %DESC_NEWLINE_ADD="   * "
  72. #
  73. #    1. DESC_NEWLINE     - YES/NO to add/remove new line strings.
  74. #    2. DESC_NEWLINE_ADD - The string to be added in front of each new line of description.
  75. #    3. AUTO_VIEW        - Automatically view the output result?
  76. #
  77. #############################################################################
  78.  
  79. %AUTO_VIEW=Y
  80.  
  81. #############################################################################
  82. # Definition for BOOKMARKS & FOLDERS blocks:
  83. #############################################################################
  84.  
  85. {BOOKMARKS}
  86.     $FOLDER$ - $TITLE$
  87. {/BOOKMARKS}
  88.  
  89. {FOLDERS:FOLDER_LIST}
  90.     $FOLDER$$TITLE$
  91. {/FOLDERS}
  92.  
  93. {FOLDERS}
  94. $BOOKMARKS$
  95. {/FOLDERS}
  96.  
  97. {FOLDERS(T):TOP_FOLDERS_ONLY}
  98. ** All Bookmarks in $FOLDER$$TITLE$ (no sub-folers) **
  99. $BOOKMARKS$
  100. {/FOLDERS}
  101.  
  102. {FOLDERS(A):ALL_BOOKMARKS_IN_ALL_FOLDERS}
  103. ** All Bookmarks in $FOLDER$$TITLE# **
  104. $BOOKMARKS$
  105. {/FOLDERS}
  106.  
  107. {FOLDERS(TA):TOP_FOLDERS_AND_ALL_BOOKMARKS}
  108. ** All Bookmarks in $FOLDER$$TITLE$ **
  109. $BOOKMARKS$
  110. {/FOLDERS}
  111.  
  112.  
  113.  
  114. #############################################################################
  115. # The main output file:
  116. #############################################################################
  117.  
  118. {MAIN:*.TXT}
  119. This is an example template to show how the new
  120. "Export Selection with Template" feature works.
  121.  
  122. Please take a look at the template file Samples.tpl
  123. and compare it with the output file to see the output file
  124. was generated.
  125.  
  126. For a complete reference, please see the Help file.
  127.  
  128.  
  129. ******************** Available Built-in General Parameters ********************
  130.  
  131.     1. VERSION       - $VERSION$
  132.     2. USER          - $USER$
  133.     3. EMAIL         - $EMAIL$
  134.     4. SERIAL        - $SERIAL$
  135.     5. TEMPLATE_DIR  - $TEMPLATE_DIR$
  136.     6. TEMPLATE_FILE - $TEMPLATE_FILE$
  137.     7. OUTPUT_DIR    - $OUTPUT_DIR$
  138.     8. OUTPUT_FILE   - $OUTPUT_FILE$
  139.  
  140. ************************* List of All Folders *************************
  141.  
  142. $FOLDER_LIST$
  143.  
  144. ************************* List of All Bookmarks *************************
  145.  
  146. $BOOKMARKS$
  147.  
  148. ************************ The FOLDERS Block with BOOKMARKS ************************
  149.  
  150. $FOLDERS$
  151.  
  152. ************************* The (T) Option in FOLDERS Block *************************
  153.  
  154. $TOP_FOLDERS_ONLY$
  155.  
  156. ************************* The (A) Option in FOLDERS Bolck *************************
  157.  
  158. This will generates lots of outputs.  If you want to see the result, please edit the
  159. template file to replace the equal-sign with the dollar-sign:
  160.  
  161. =ALL_BOOKMARKS_IN_ALL_FOLDERS=
  162.  
  163. ************************* The (TA) Option in FOLDERS Bolck *************************
  164.  
  165. $TOP_FOLDERS_AND_ALL_BOOKMARKS$
  166.  
  167. **************************************************
  168. ** Exported by Compass $VERSION$
  169. ** Export Template - Sample.tpl
  170. **************************************************
  171. {/MAIN}
  172.